Skip to content

feat: add allowReserved support for query parameters in respect#2656

Open
n0rahh wants to merge 5 commits intomainfrom
feat/support-allow-reserved-option
Open

feat: add allowReserved support for query parameters in respect#2656
n0rahh wants to merge 5 commits intomainfrom
feat/support-allow-reserved-option

Conversation

@n0rahh
Copy link
Contributor

@n0rahh n0rahh commented Mar 13, 2026

What/Why/How?

What: Support for OpenAPI allowReserved on query parameters in Respect.

Why: Aligns with Portal Replay behavior: when allowReserved: true, RFC 3986 reserved characters in query values are left unencoded so URL-like values (e.g. callback URLs) work as expected.

How: Pass through allowReserved; use encodeURIValue(value, allowReserved) for query values instead of encodeURIComponent everywhere.

Reference

resolves https://github.com/Redocly/redocly/issues/21326

Testing

Screenshots (optional)

Check yourself

  • Code changed? - Tested with Redoc/Realm/Reunite (internal)
  • All new/updated code is covered by tests
  • New package installed? - Tested in different environments (browser/node)
  • Documentation update considered

Security

  • The security impact of the change has been considered
  • Code follows company security practices and guidelines

@changeset-bot
Copy link

changeset-bot bot commented Mar 13, 2026

🦋 Changeset detected

Latest commit: bd3bdb8

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 3 packages
Name Type
@redocly/cli Minor
@redocly/openapi-core Minor
@redocly/respect-core Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 79.41% (🎯 79%) 6483 / 8163
🔵 Statements 78.87% (🎯 78%) 6704 / 8499
🔵 Functions 82.78% (🎯 82%) 1327 / 1603
🔵 Branches 71.36% (🎯 71%) 4423 / 6198
File Coverage
File Stmts Branches Functions Lines Uncovered Lines
Changed Files
packages/core/src/types/arazzo.ts 100% 100% 100% 100%
packages/respect-core/src/arazzo-schema.ts 0% 100% 100% 0% 1-449
packages/respect-core/src/modules/description-parser/get-request-data-from-openapi.ts 91.3% 77.77% 100% 91.3% 79, 88
packages/respect-core/src/utils/api-fetcher.ts 55.1% 45.37% 73.33% 54.79% 89-95, 125, 151-167, 178-179, 189-192, 197-200, 205, 208-229, 242-255, 263, 310-316, 323-401, 409, 417, 438, 453, 460, 463, 467
packages/respect-core/src/utils/url-encoding.ts 100% 100% 100% 100%
Generated in workflow #9018 for commit bd3bdb8 by the Vitest Coverage Report Action

@github-actions
Copy link
Contributor

github-actions bot commented Mar 13, 2026

CLI Version Mean Time ± Std Dev (s) Relative Performance (Lower is Faster)
cli-latest 3.546s ± 0.061s ▓ 1.00x (Fastest)
cli-next 3.612s ± 0.038s ▓ 1.02x

@n0rahh n0rahh added the snapshot Create experimental release PR label Mar 16, 2026
@github-actions
Copy link
Contributor

📦 A new experimental 🧪 version v0.0.0-snapshot.1773672987 of Redocly CLI has been published for testing.

Install with NPM:

npm install @redocly/cli@0.0.0-snapshot.1773672987
# or
npm install @redocly/openapi-core@0.0.0-snapshot.1773672987
# or
npm install @redocly/respect-core@0.0.0-snapshot.1773672987

⚠️ Note: This is a development build and may contain unstable features.

@n0rahh n0rahh marked this pull request as ready for review March 16, 2026 15:01
@n0rahh n0rahh requested review from a team as code owners March 16, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

snapshot Create experimental release PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants